Skip to content

feat(Layout): add style support ShowTabInHeader parameter#5773

Merged
ArgoZhang merged 6 commits intomainfrom
refactor-layout
Apr 2, 2025
Merged

feat(Layout): add style support ShowTabInHeader parameter#5773
ArgoZhang merged 6 commits intomainfrom
refactor-layout

Conversation

@ArgoZhang
Copy link
Copy Markdown
Member

@ArgoZhang ArgoZhang commented Apr 2, 2025

Link issues

fixes #5772

Summary By Copilot

This pull request includes updates to the BootstrapBlazor project, focusing on version updates, layout enhancements, and tab component improvements. The most important changes include updating the project version, enhancing the layout styles, and refining the tab component behavior and styles.

Version Update:

Layout Enhancements:

Tab Component Improvements:

Regression?

  • Yes
  • No

Risk

  • High
  • Medium
  • Low

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Enhance layout and tab component styling with improved support for ShowTabInHeader parameter and chrome-style tabs

New Features:

  • Add style support for ShowTabInHeader parameter in Layout component

Bug Fixes:

  • Move tab registration to OnParametersSet to ensure proper initialization

Enhancements:

  • Improve tab component rendering and initialization logic
  • Update tab and layout styling for better visual consistency

@bb-auto bb-auto Bot added the enhancement New feature or request label Apr 2, 2025
@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Apr 2, 2025

Reviewer's Guide by Sourcery

This pull request updates the project version, enhances layout styles to support tabs in the header, and refines tab component behavior and styles. The primary changes involve updating the project version, modifying layout-related SCSS files, and adjusting the Tab component's Razor and C# files.

Sequence diagram for Tab registration with Layout

sequenceDiagram
    participant Tab
    participant Layout

    Tab->>Tab: OnParametersSet()
    alt Layout.ShowTabInHeader is true
        Tab->>Layout: RegisterTab(this)
    else Layout.ShowTabInHeader is false
        Tab->>Tab: TabHeader = null
    end
Loading

Updated class diagram for the Tab component

classDiagram
  class Tab {
    +Layout Layout
    +bool ShowActiveBar
    +TabStyle TabStyle
    +void OnInitialized()
    +void OnParametersSet()
  }

  note for Tab.OnInitialized "Layout.RegisterTab call removed from OnInitialized"
  note for Tab.OnParametersSet "Layout.RegisterTab call moved to OnParametersSet"
Loading

Updated class diagram for the Layout component

classDiagram
  class Layout {
    +void RegisterTab(Tab tab)
    +bool ShowTabInHeader
  }
Loading

File-Level Changes

Change Details Files
Updated the project's version number.
  • Incremented the version number from 9.5.1 to 9.5.2.
src/BootstrapBlazor/BootstrapBlazor.csproj
Enhanced layout styles to accommodate tabs within the main layout area.
  • Added styles for .tabs within .layout-main to remove margins and borders.
  • Added styles for .tabs.tabs-chrome to adjust height and width properties.
  • Added styles for tabs-chrome to customize the appearance of tabs in the header, including background color, text color, and item height.
src/BootstrapBlazor/Components/Layout/Layout.razor.scss
Refined the tab component's behavior and styles.
  • Modified the condition to display the active bar only when TabStyle is Default.
  • Moved the Layout.RegisterTab call from OnInitialized to OnParametersSet to ensure proper initialization based on parameters.
  • Updated CSS variable for tab header height from --bb-tabs-header-height to --bb-tabs-chrome-item-height for consistency.
  • Updated related styles to use the new CSS variable.
src/BootstrapBlazor/Components/Tab/Tab.razor.cs
src/BootstrapBlazor/Components/Tab/Tab.razor.scss
src/BootstrapBlazor/Components/Tab/Tab.razor

Assessment against linked issues

Issue Objective Addressed Explanation
#5772 Add style support for the ShowTabInHeader parameter in the Layout component.

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@bb-auto bb-auto Bot added this to the v9.5.0 milestone Apr 2, 2025
Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Moving Layout.RegisterTab to OnParametersSet looks correct, but consider what happens when ShowTabInHeader changes after the component is initialized.
  • Be careful when setting height to 100% in CSS, as it can have unexpected results if the parent element doesn't have a defined height.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (208d440) to head (203eff2).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5773   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          658       658           
  Lines        30029     30032    +3     
  Branches      4243      4243           
=========================================
+ Hits         30029     30032    +3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ArgoZhang ArgoZhang merged commit 6f3e917 into main Apr 2, 2025
4 checks passed
@ArgoZhang ArgoZhang deleted the refactor-layout branch April 2, 2025 09:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat(Layout): add style support ShowTabInHeader parameter

1 participant